Documentation for Users  2.0.0
Perception Toolbox for Virtual Reality (PTVR) Manual
The3DWorld Class Reference

Public Member Functions

def __init__ (self, name_of_subject="DummyUser", resultsPath="", output_headset=False, output_raw_sranipall_gaze_data=False, output_hand_controller=False, hand_controller_save_sampling_period=10, hand_controller_events_are_recorded=False, headset_save_sampling_period=10, operatorMode=False, eyetracking=False, headset_manufacturer="Vive")
 
def set_monocular (self, masked_eye=MaskedEye.LEFT_EYE, masked_eye_background_color=color.RGB255Color())
 
def translate_coordinate_system_along_global (self, translation=np.array([0.0, 0.0, 0.0]))
 
def translate_coordinate_system_along_current (self, translation=np.array([0.0, 0.0, 0.0]))
 
def rotate_coordinate_system_about_current_x (self, rotation_deg)
 
def rotate_coordinate_system_about_current_y (self, rotation_deg)
 
def rotate_coordinate_system_about_current_z (self, rotation_deg)
 
def rotate_coordinate_system_about_global_x (self, rotation_deg)
 
def rotate_coordinate_system_about_global_y (self, rotation_deg)
 
def rotate_coordinate_system_about_global_z (self, rotation_deg)
 
def get_axes (self)
 
def get_rightward_axis (self)
 
def get_upward_axis (self)
 
def get_forward_axis (self)
 
def get_position (self)
 
def get_coordinate_system (self)
 
def reset_coordinate_system (self)
 
def SetIdScene (self, count)
 
def add_scene (self, individual_scene=PTVR.Stimuli.Scenes.Scene())
 
def write_calculators (self, fp)
 
def write_metadata (self, fp)
 
def write_scenes (self, fp)
 
def write (self)
 

Data Fields

 calculatorManager
 
 created
 
 details3DWorld
 
 handControllerLeft
 
 handControllerRight
 
 headset_manufacturer
 
 headset
 
 eyeLeft
 
 eyeRight
 
 eyeCombined
 
 originCurrentCS
 
 originGlobalCS
 
 coordinate_system
 
 last_coordinate_system_index
 
 provided_results_path
 
 eyetracking
 
 results_path
 
 user
 
 scenes
 
 leftBlind
 
 rightBlind
 
 headSaveSamplingPeriod
 
 handControllerSaveSamplingPeriod
 
 hasOperator
 
 origin
 
 outputHead
 
 outputGaze
 
 outputLaser
 
 hand_controller_events_are_recorded
 
 countValue
 
 leftBackgroundColor
 
 rightBackgroundColor
 
 translation_vector
 

Static Public Attributes

dictionary custom_data = {}
 
list id_scene = []
 
list coordinate_system = []
 

Private Member Functions

def __add_a_coordinate_system (self, vt)
 
def _create_folder_description_files (self, path_to_json_directory)
 

Detailed Description

Parameters
----------

headset_manufacturer : "Vive" (default) or "Oculus"

    "Vive" refers to the HTC Vive pro series headsets.

    "Oculus" refers to Quest 1, 2 or 3 headsets (in keeping with OpenXR terminology)


Returns
-------
None.

Definition at line 60 of file Visual.py.


The documentation for this class was generated from the following file: